2-phase attachment upload uses AttachmentUploadDescriptor which allows PUT and custom header passing (includes breaking changes) #94
+35
−7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jiwon-oai
force-pushed
the
upload-put-support
branch
from
f0b1f90 to
b2441b0
Compare
jiwon-oai
commented
Jan 5, 2026
| attachment = await attachment_store.create_attachment( | ||
| request.params, context | ||
| ) | ||
| await self.store.save_attachment(attachment, context=context) |
Collaborator
Author
There was a problem hiding this comment.
Throwing in this breaking cleanup since the upload descriptor change is already breaking.
This makes it so that ChatKitServer is in charge of saving the attachment metadata to the data store, just as it is responsible for self.store.delete_attachment below. No longer forces the attachment store to have access to data store just to save the attachment metadata.
jiwon-oai
commented
Jan 5, 2026
| id: str | ||
| name: str | ||
| mime_type: str | ||
| upload_url: AnyUrl | None = None |
Collaborator
Author
There was a problem hiding this comment.
Removing for a clean break. The client will continue to support this field from older versions.
weedon-openai
approved these changes
Jan 5, 2026
chatkit/types.py
Outdated
| """Two-phase upload instructions.""" | ||
|
|
||
| url: AnyUrl | ||
| method: Literal["put", "post"] |
jiwon-oai
force-pushed
the
upload-put-support
branch
from
b2441b0 to
24b53f9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
Attachment.upload_descriptorwhich specifies the upload method (post vs. put) and any custom headers to pass along.Breaking:
Attachment.upload_urlAttachmentsCreateReqfor phase 1 of a 2-phase upload, ChatKitServer callsawait self.store.save_attachment(attachment, context=context)after calling attachment_store's create method. Previously it was the responsibility of attachment_store to save the attachment to the data store, which forced the attachment store to have access to / depend on the thread data store.